<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: xsecure_lms.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xsecure__lms_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xsecure_lms.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains definitions and interface used in LMS. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
----- ---- -------- ----------------------------------------------------------
5.4   kal  07/24/24  Initial release</pre><pre></pre><dl class="section note"><dt>Note</dt><dd></dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a292e1e3bc9bd3759b76c98cfd8196deb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsecure__lms_8c.html#a292e1e3bc9bd3759b76c98cfd8196deb">XSecure_LmsLookupParamSet</a> (<a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554a">XSecure_LmsType</a> <a class="el" href="xsecure__lms__ots_8h.html#a8edafe9629f0c895a14f0e7445bcbd5c">Type</a>, <a class="el" href="struct_x_secure___lms_param.html">XSecure_LmsParam</a> **Parameters)</td></tr>
<tr class="memdesc:a292e1e3bc9bd3759b76c98cfd8196deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the parameters for the type of LMS type.  <a href="#a292e1e3bc9bd3759b76c98cfd8196deb">More...</a><br/></td></tr>
<tr class="separator:a292e1e3bc9bd3759b76c98cfd8196deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a292e1e3bc9bd3759b76c98cfd8196deb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_LmsLookupParamSet </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554a">XSecure_LmsType</a>&#160;</td>
          <td class="paramname"><em>Type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_secure___lms_param.html">XSecure_LmsParam</a> **&#160;</td>
          <td class="paramname"><em>Parameters</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the parameters for the type of LMS type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Type</td><td>XSecure_LmsType, type of OTS algorithm selected </td></tr>
    <tr><td class="paramname">Parameters</td><td>Pointer to array location where all predefined parameter values are present <a class="el" href="struct_x_secure___lms_param.html">XSecure_LmsParam</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS - Valid type is passed, and parameters are assigned</li>
<li>XST_FAILURE - If not a valid type is passed </li>
</ul>
</dd></dl>
<p>160U</p>
<p>320U</p>
<p>480U</p>
<p>640U</p>
<p>160U</p>
<p>320U</p>
<p>480U</p>
<p>640U </p>

<p>References <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aa2c49e5b42557925b34b58f162bb3fc31">XSECURE_LMS_NOT_SUPPORTED</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aafb791256faee65ba5ad4b6ca3c3363bf">XSECURE_LMS_SHA256_M32_H10</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aa780120c8960bf510af7d609062de8969">XSECURE_LMS_SHA256_M32_H15</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aa80dcd06ec2001fac0c12c665b950a9cb">XSECURE_LMS_SHA256_M32_H20</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aafac10a46324772bf350225e72bd115ab">XSECURE_LMS_SHAKE_M32_H10</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aa7a1f0dcb8420bfd39406dd2b599dfe8d">XSECURE_LMS_SHAKE_M32_H15</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aa86367264345526110c4b59286d3186b0">XSECURE_LMS_SHAKE_M32_H20</a>, <a class="el" href="xsecure__lms_8h.html#a87557e3db575e6dc9ad6ddfc596a554aa7cc64a98b98653720f6721fd404861ee">XSECURE_LMS_SHAKE_M32_H5</a>, <a class="el" href="group__xsecure__error__codes.html#ggacba8dc046b878afa42fdc63ce1dc2574a5b5ca03645d66f1e6bd95539a5928abf">XSECURE_LMS_TYPE_LOOKUP_GLITCH_ERROR</a>, <a class="el" href="xsecure__lms_8h.html#af76f88234c6663ffdf82535f7acb89ad">XSECURE_LMS_TYPE_MAX_SUPPORTED</a>, <a class="el" href="group__xsecure__error__codes.html#ggacba8dc046b878afa42fdc63ce1dc2574aa15d24504679d0c2ed1521469fa6ab66">XSECURE_LMS_TYPE_UNSUPPORTED_ERROR</a>, <a class="el" href="group__xsecure__helper__server__apis.html#ga5738537e51cc4a10f5753b092955c4b0">XSECURE_SHA2_256_HASH_LEN</a>, <a class="el" href="group__xsecure__sha__example__apis.html#gad83e90d954ca31ac3d9cc687321cdb2d">XSECURE_SHAKE_256</a>, and <a class="el" href="group__xsecure__helper__server__apis.html#ga7af13060e1711b13d1d20bdbed3c20f5">XSECURE_SHAKE_256_HASH_LEN</a>.</p>

<p>Referenced by <a class="el" href="xsecure__lms__core_8h.html#a4fe7fa250fbd0908fb92b6f65becf08e">XSecure_GetLmsHashAlgo()</a>, <a class="el" href="xsecure__lms__core_8h.html#a112da8c38a140d02852bd8f93ab78e2f">XSecure_HssFinish()</a>, <a class="el" href="xsecure__lms__core_8h.html#a981b22fbc50d9cd6f91c16604754f078">XSecure_HssInit()</a>, and <a class="el" href="xsecure__lms__core_8h.html#a6b50f9fb052dd231c50ea15138f17ff7">XSecure_LmsSignatureVerification()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
